<HTML>

<HEAD>
	<TITLE>EETransfer Off-line documentation</TITLE>
</HEAD>

<BODY BACKGROUND="../pict/fond.gif" BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#FF0000" VLINK="#FF0000">

<TABLE WIDTH=598 BORDER=0 CELLPADDING=0 CELLSPACING=0>


<TR >
		<TD WIDTH=120 ALIGN="center" NOWRAP>
		<A HREF="mailto:mail@easter-eggs.com" >
		<IMG SRC="../pict/mailee.gif" ALT="Mail to EE" WIDTH=81 HEIGHT=19 BORDER=0>
		</A>
		</TD>

		<TD WIDTH=20 NOWRAP>
		</TD>
		
		<TD WIDTH=5 NOWRAP>
		</TD>
		
		<TD WIDTH=226  ALIGN="center" VALIGN="top" NOWRAP>
		<IMG SRC="../pict/logo.gif" WIDTH=100 HEIGHT=100 BORDER=0>
		</TD>


		<TD WIDTH=227 VALIGN="center" NOWRAP>
		<H1>EETransfer Off-line documentation</H1>
		<FONT SIZE=+2><B><A HREF="../docsum.html">Back to summary</A></B></FONT>
		</TD>
		


</TR>

<TR >
		<TD WIDTH=120 >
		</TD>

		<TD WIDTH=20 >
		</TD>
		
		<TD WIDTH=5>
		</TD>

		<TD WIDTH=453  COLSPAN=2>
		<IMG SRC="../pict/bbar.gif" WIDTH=453 HEIGHT=30 BORDER=0>
		</TD>


</TR>
	
<TR >
		<TD WIDTH=120 ALIGN="center" VALIGN="top">
		Updated 97/06/24
		</TD>

		<TD WIDTH=20 >
		</TD>
		
		<TD WIDTH=5>
		</TD>

		<TD WIDTH=453  ALIGN="left" COLSPAN=2> 
		<FONT SIZE=+2><B>ConnectSerial</B></FONT>
		<BR><HR>
<B>Launch a serial connection, then pause as soon as the Newton is connected.
When its execution is resumed, it disconnects.</B>

<BR><BR>



<B>* bps</B>

<BR>

<B>type:</B> integer
<BR>
<B>default value:</B> k9600bps (9600)

<BR>
<BR>
You can use the following constants to specify the connection speed:
<BR>
<B>Constant Value</B>
<BR>
<B>kExternalClock </B>1
<BR>
<B>k300bps </B>300
<BR>
<B>k600bps </B>600
<BR>
<B>k1200bps </B>1200
<BR>
<B>k2400bps </B>2400
<BR>
<B>k4800bps </B>4800
<BR>
<B>k7200bps </B>7200
<BR>
<B>k9600bps </B>9600
<BR>
<B>k12000bps </B>12000
<BR>
<B>k14400bps </B>14400
<BR>
<B>k19200bps </B>19200
<BR>
<B>k38400bps </B>38400
<BR>
<B>k57600bps </B>57600
<BR>
<B>k115200bps </B>115200
<BR>
<B>k230400bps </B>230400

<BR><BR>



<B>* dataBits</B>


<BR>
<B>type:</B> integer
<BR>
<B>default value:</B> k8DataBits (8)
<BR><BR>


You can use the following constants:
<BR>
<B>Constant Value</B> (number of data bits)
<BR>
<B>k5DataBits </B>5
<BR>
<B>k6DataBits </B>6
<BR>
<B>k7DataBits </B>7
<BR>
<B>k8DataBits </B>8
<BR><BR>




<B>* endpoint</B>



<B>type:</B> Newton endpoint

<BR>

<I>This slot is returned by the instruction. Its initial value is ignored</I>



<BR><BR>

<B>* flowControl</B>


<BR>
<B>type:</B> symbol or nil
<BR>
<B>default value:</B> nil

<BR>

You can use the following values:
<BR><BR>
<B>Value	Description</B>

<B>nil</B> no flow control

<B>'hard</B> Hardware Handshake (DTR & CTS)

<B>'soft</B> Software Handshake (XON/XOFF)


<BR><BR>


<B>* listen</B>


<BR>
<B>type:</B> boolean

<B>default value:</B> nil

<BR><BR>



<B>* listenTimeout</B>


<BR>
<B>type:</B> integer
<BR>
<B>default value:</B> kNoTimeout (0)

<BR>

An integer specifying the time, in milliseconds, that the system should
allow for the Newton to listen. If you use this slot, specify an integer
greater than 30.
<BR><BR>




<B>* parity</B>



<B>type:</B> integer

<B>default value:</B> kNoParity (0)

<BR>

You can use the following constants:
<BR><BR>
<B>Constant Value Description</B>
<BR>
<B>kNoParity</B>	0		no parity
<BR>
<B>kOddParity</B>	1		odd parity
<BR>
<B>kEvenParity</B>	2		even parity
<BR><BR>




<B>* receiveBufferSize</B>

<BR>

<B>type:</B> integer
<BR>
<B>default value:</B> 1040 (a little more than 1 KB)
<BR>


This slot lets you increase the size of the input buffer used by the
serial tool. Buffers larger than 4KB are not supported; an error results if
you specify too large a buffer. Also note you can get an out-of-memory
error at connect time if the serial tool cannot allocate the buffer.
<BR><BR>
<I>This option is often useful because appropriate buffer size can increase
performance and decrease overrun errors. For communications that use
packet-oriented protocols, a good buffer size is one that is a few bytes
larger than the typical packet size.</I>
<BR><BR>
The input buffer can be increased, especially for data rates above 9600
bps. If no flow control is operating, input buffer size may be the only way
to control overruns.
<BR>
The total size of the input buffer is limited to 4 KB, which includes
about 8 bytes per marker. Typical input buffer size is 256 to 1024 bytes.
<BR><BR>
<I>Note that the usable size of a buffer is usually between one and four
bytes less than the buffer size, because of DMA boundary constraints and
other considerations.</I>

<BR><BR>



<B>* serialPort</B>

<BR>

<B>type:</B> string
<BR>
<B>default value:</B> kHWLocExternalSerial ("extr")

<BR>

The possible values for the slot are listed below. <I>Note that these
locations are hardware platform dependent.</I>
<BR><BR>
<B>Constant Value Description</B>
<BR>
<B>kHWLocExternalSerial</B>	"extr"	Use the external serial port.
<BR>
<B>kHWLocBuiltInIR</B>			"infr"	Use the built-in infrared port.
<BR>
<B>kHWLocBuiltInModem</B>		"mdem"	Use the built-in modem.
<BR>
<B>kHWLocPCMCIASlot1</B>		"slt1"	Use the application card in slot 1.
<BR>
<B>kHWLocPCMCIASlot2</B>		"slt2"	Use the application card in slot 2.
<BR>
<B>kHWLocPCMCIAAnySlot</B>		"slot"	Use the application card in any slot.
<BR><BR>




<B>* stopBits</B>


<BR>
<B>type:</B> integer
<BR>
<B>default value:</B> k1StopBits (0)
<BR>


You can use the following constants:
<BR><BR>
<B>Constant Value Number of stop bits</B>
<BR>
<B>k1StopBits</B> 0 1 stop bit

<B>k1pt5StopBits</B> 1 1.5 stop bits

<B>k2StopBits</B> 2 2 stop bits

<BR><BR>



<B>* transport</B>

<BR>

<B>type:</B> frame

<B>default value:</B> nil
<BR>


<I>The transport must always be EETransfer.</I>
<BR>
<B>Note:</B> Before the script executes itself, the global variable "<B>transport</B>"
is automatically set to EETransfer. So if you don't use a slot
"<B>globalSymbols</B>" you don't have to (and you should not) provide a slot
"<B>transport</B>". Otherwise, the "<B>globalSymbols</B>" slot must contain a slot:
<BR>
<B>transport:</B> 'transport,


		</TD>

		
</TR>

<TR >
		<TD WIDTH=120 >
		</TD>

		<TD WIDTH=20 >
		</TD>
		
		<TD WIDTH=5>
		</TD>

		<TD WIDTH=453  COLSPAN=2>
		<IMG SRC="../pict/bbar.gif" WIDTH=453 HEIGHT=30 BORDER=0>
		</TD>


</TR>


<TR >
		<TD WIDTH=120 >
		</TD>

		<TD WIDTH=20 >
		</TD>
		
		<TD WIDTH=5>
		</TD>

		<TD WIDTH=453  COLSPAN=2>
		<IMG SRC="../pict/bar.gif" WIDTH=453 HEIGHT=30 BORDER=0>
		</TD>


</TR>

<TR >
		<TD WIDTH=120 >
		&copy;1997 Easter-eggs<BR>
		All trademarks mentioned are the property of their respective owners
		</TD>

		<TD WIDTH=20 >
		</TD>
		
		<TD WIDTH=5>
		</TD>
		
		<TD WIDTH=226  VALIGN="top">
		</TD>


		<TD WIDTH=227 ALIGN="right" VALIGN="top">
		</TD>
		


</TR>


</TABLE>

</BODY>

</HTML>